home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / preference programme / muiscreenmode_v1.5 / docs / english / muiscreenmode.guide (.txt) next >
Amigaguide Document  |  1996-04-07  |  21KB  |  330 lines

  1. @database "MUIScreenMode"
  2. @wordwrap
  3. @NODE Main "The MUIScreenMode Preference Editor"
  4. @{u}@{b}MUIScreenMode v1.4@{ub} - 
  5.  1995 Cyril DEBLE@{uu}
  6. @{i}A screenmode preference replacement using MUI.@{ui}
  7.     This document describes how to use the MUIScreenMode preferences editor. Please select an item from the table of contents listed below:
  8.   @{" Features                 " link Features     }
  9.   @{" Requirements             " link Requirements }
  10.   @{" Installation             " link Installation }
  11.   @{" Usage                    " link Usage        }
  12.   @{" Author                   " link Author       }
  13.   @{" Copyright & Disclaimer   " link Copyright    }
  14.   @{" History                  " link History      }
  15.   @{" About MUI                " link MUI          }
  16. @ENDNODE
  17. @NODE Features " MUISrenMode Features "
  18. @{u}Description of MUIScreenMode@{uu}
  19. This program is a replacement of the Commodore ScreenMode preferences. It does the same things as Commodore's screenmode prefs but also features:
  20. - Nice font sensitive GUI (@{"MUI" link MUI }).
  21. - Fully compatible with system 3.0 screenmode.
  22. - @{"Rescan" link BT_Rech} of system screenmode list without quitting.
  23. - Supports @{"HAM" link CH_HAM} mode !
  24. - Display mode ID in @{"Mode Properties Listview" link LV_InfoEcr}.
  25. - Open on specified pubscreen.
  26. - Use sys/prefs.catalog (No new catalog to add).
  27. - Use ENV:Def_Prefs.info @{"icon" link Preset} for preset (No more build in icon).
  28. - On-line @{"help" link Help}.
  29. - And @{"more" link History}...
  30. @ENDNODE
  31. @NODE Requirements "Requirements of MUIScreenMode"
  32. @{u}Requirements@{uu}
  33. For running MUIScreenMode you need the following software :
  34. - AmigaOS version 3.0 or better.
  35. - @{"MUI" link MUI} version 2.3 or better.
  36. @ENDNODE
  37. @NODE Installation "Installation of MUIScreenMode"
  38. @{u}Installation@{uu}
  39.     To install MUIScreenMode you can use the installer script by double-clicking on its icon.
  40.     If you want to install it manually it's also very easy, simply drag the MUIScreenMode icon to the prefs drawer. If you want to you can delete the old screenmode preference and rename MUIScreenMode as ScreenMode.
  41.     If you want the on-line @{"help" link Help} the docs drawer should be copied to the HELP: drawer. If you want to use the @{"icon" link Preset} option you have to copy the icon in the env/ drawer to the ENV:Sys and ENVARC:Sys drawers or simply put one of yours.
  42. @ENDNODE
  43. @NODE Usage "Usage of MUIScreenMode"
  44. @{u}Usage@{uu}
  45.     To use the preference editor, either double-click on its icon in Workbench, or run it from a shell. You should see the main editing @{"window" link GUI} pop up.
  46. MUIScreenMode support :
  47.   @{" Running From Workbench     " link WB           }
  48.   @{" Running From CLI           " link CLI          }
  49.   @{" Running From a Preset icon " link Preset       }
  50. @ENDNODE
  51. @NODE WB "Running from Workbench"
  52. @{u}Running from Workbench@{uu}
  53.     When running fron Workbench you can use TOOLTYPES. They are used for setting the values of options given by the program, so you don't have to reset these values every time you start the program.
  54. These tooltypes are:
  55. - @{b}PUBSCREEN@{ub}:
  56.     This tooltype allows to specify the public screen where the @{"GUI" link GUI} should open.
  57. Example: PUBSCREEN=DOPUS.1
  58. - @{b}CREATEICONS@{ub}:
  59.     Set this tooltype to YES if you whant MUIScreenMode to add an @{"icon" link Preset} when saving a preference file.
  60. Example: CREATEICONS=YES
  61. - @{b}FLUSHLIBS@{ub}:
  62.     Set this tooltype to YES if you whant MUIScreenMode to flush MUI library when quitting. Nice for those low on memory.
  63. Example: FLUSHLIBS=YES
  64. @ENDNODE
  65. @NODE CLI "Running from CLI"
  66. @{u}Running from CLI@{uu}
  67. When running fron CLI you can use following options:
  68. - @{b}FILE@{ub}:
  69.     This is the name of the preference file to load. Simply type its name as the argument.
  70. Example: MUIScreenMode SYS:Prefs/Presets/Default.screenmode
  71. - @{b}PUBSCREEN@{ub}:
  72.     This is the name of the public screen where MUIScreenMode will open its @{"GUI" link GUI}. Type the name of the screen just after the PUBSCREEN keyword.
  73. Example: MUIScreenMode PUBSCREEN DOPUS.1
  74. - @{b}EDIT@{ub}:
  75.     The previously specified preference file will be edited in the @{"GUI" link GUI}. (In fact this switch is alway specified except when either the USE or the SAVE switch is specified).
  76. - @{b}USE@{ub}:
  77.     The previously specified preference file will be saved to ENV:. Thus the Workbench will be updated. Same as the @{"Use Button" link BT_Utiliser} without opening the @{"GUI" link GUI}.
  78. - @{b}SAVE@{ub}:
  79.     The previously specified preference file will be saved to ENV: and ENVARC: making the change permanent. Workbench will be also udated. Same as @{"Save Button" link BT_Sauver} without opening the @{"GUI" link GUI}.
  80. @ENDNODE
  81. @NODE Preset "Running from a Preset Icon"
  82. @{u}Running from a Preset Icon@{uu}
  83.     When you save a preference file with an icon you can set the tooltype ACTION with the following arguments :
  84. - @{b}EDIT@{ub} :
  85.     The preference file will be edited in the @{"GUI" link GUI}.
  86. Example: ACTION=EDIT
  87. - @{b}USE@{ub} :
  88.     The preference file will be saved to ENV:. Thus the Workbench will be updated. Same as the @{"Use Button" link BT_Utiliser} without opening the @{"GUI" link GUI}. (This is the default argument when saving with an icon)
  89. Example: ACTION=USE
  90. - @{b}SAVE@{ub} :
  91.     The preference file will be saved to ENV: and ENVARC: making the change permanent. Workbench will also be updated. Same as the @{"Save Button" link BT_Sauver} without opening the @{"GUI" link GUI}.
  92. Example: ACTION=SAVE
  93. @ENDNODE
  94. @NODE GUI "The GUI of MUIScreenMode"
  95. @{u}The GUI of MUIScreenMode@{uu}
  96.     In the Borders of the window there are the usual gadgets you can find in nearly every application. First there are the close, the depth, the 2-Sizes and, at the bottom-right, the Sizing-Gadget.
  97.     Additionally there's an Iconify-Gadget for iconifying the window. When using this button, the window will disappear and an AppIcon will appear in the root of the workbench.
  98.     The GUI supports the standard set of preference @{"menu" link Menu} and on-line @{"help" link Help}.
  99. All gadgets of the window are explained below:
  100.   @{" DisplayMode Listview " link LV_ModeAff }
  101.   @{" Update Button        " link BT_Rech }
  102.   @{" Properties Listview  " link LV_InfoEcr }
  103.   @{" Colour Slider        " link SL_Couleur }
  104.   @{" Size String Gadgets  " link GAD_String }
  105.   @{" Default Gadgets      " link CH_Defaut }
  106.   @{" Autoscroll CheckMark " link CH_Depl }
  107.   @{" HAM CheckMark        " link CH_HAM }
  108.   @{" Save Button          " link BT_Sauver }
  109.   @{" Use Button           " link BT_Utiliser }
  110.   @{" Cancel Button        " link BT_Annuler }
  111. @ENDNODE
  112. @NODE Menu "MUIScreenMode Menu"
  113. @{u}Menu@{uu}
  114.     MUIScreenMode's menus are the same as those in Commodore's screenmode. Various items are:
  115. @{i}Project Menu@{i}
  116. - @{b}Open@{ub} :
  117.     Open a requester where you can choose a screenmode preset file previously saved.
  118. - @{b}Save as@{ub} :
  119.     Save current screenmode settings to a preset file. An icon will be appended depending on the Create Icon option. (See below)
  120. - @{b}About@{ub} :
  121.     Open the about requester.
  122. - @{b}Quit@{ub} :
  123.     Leave the program without changing anything.
  124. @{i}Edit Menu@{ui}
  125. - @{b}Reset To Defaults@{ub} :
  126.     Reset screenmode gadgets to their default value. (PAL mode with default sizes)
  127. - @{b}Last Saved@{ub} :
  128.     Load previously saved prefs file. (The file in ENVARC:)
  129. - @{b}Restore Settings@{ub} :
  130.     Load the prefs file in ENV: thus resetting gadgets to the value used when MUIScreenMode was loaded.
  131. @{i}Options Menu@{i}
  132. - @{b}Create Icons ?@{ub} :
  133.     If checked the program will create an icon when saving the preference file.
  134. - @{b}Flushlibs@{ub} :
  135.     If checked the program will flush the MUI library when quitting.
  136. @ENDNODE
  137. @NODE Help "On-line help"
  138. @{u}On-line help@{uu}
  139.     To use the on line help simply place the mouse over the gadget you need help on and press the help key.
  140. @ENDNODE
  141. @NODE LV_ModeAff "Display Mode Listview"
  142. @{u}Display Mode Listview@{uu}
  143.     Display modes available to the system are displayed in this listview. You can scan the list to discover available display modes. Every display mode shown reflects the presence of a driver in Devs/Monitors.
  144.     To select a screen mode you can click on it with the mouse. The listview can be controlled using standard MUI keys or with the scrollbar. When a mode is selected the corresponding properties are updated in the @{"Mode Properties" link LV_InfoEcr } listview.
  145.     You can also double-click on an entry to use it directly. (Same as the @{"use button" link BT_Utiliser })
  146. @ENDNODE
  147. @NODE BT_Rech "Update Button"
  148. @{u}Update Button@{uu}
  149.     This button allows to rescan system screen mode. Thus you can add new screen mode from Storage/Monitors without quitting MUIScreenMode.
  150. @ENDNODE
  151. @NODE LV_InfoEcr "Mode Properties Listview"
  152. @{u}Mode Properties Listview@{uu}
  153.     This listview shows various information about the selected screenmode. The first line shows display name followed by display ID between brackets.
  154.     Other informations are:
  155. - @{b}Visible size@{ub} :
  156.     Size with overscan of the selected display mode. This size can be edited with overscan preferences.
  157. - @{b}Minimum size@{ub} :
  158.     This is the minimum size supported by the selected display mode.
  159. - @{b}Maximum size@{ub} :
  160.     This is the maximum size supported by the selected display mode. These values may change due to low chip memory.
  161. - @{b}Maximum colors@{ub} :
  162.     This is the maximum colours supported by the selected display mode.
  163. Other properties may or may not appear depending on the selected screenmode :
  164. - @{b}Requires ECS@{ub} :
  165.     The selected display mode is availlable if you have the ECS chipset.
  166. - @{b}Interlaced@{ub} :
  167.     The selected display mode is interlaced.
  168. - @{b}Supports genlock@{ub} :
  169.     The selected display supports video peripherals like genlocks.
  170. - @{b}Draggable@{ub} :
  171.     The selected display mode supports dragging with the mouse. To drag the screen you have to click on the screen bar with left mouse button and pull up and down. This is useful to show other screens behind.
  172. - @{b}Frequencies@{ub} :
  173.     The last two numbers are the horizontal and vertical frequencie.
  174.     The listview can be controlled using standard MUI keys or using the scrollbar. At startup the properties list may be blank, it's because you have removed a driver from the system and thus there is no more information on this mode. Nevertheless you can select another mode and have the corresponding information.
  175. @ENDNODE
  176. @NODE SL_Couleur "Colour Slider"
  177. @{u}Colour Slider@{uu}
  178.     This slider allow you to choose number of color displayed in the workbench screen. The more colours you have the slower the refresh speed of the Workbench screen and the more chip memory is used.
  179.     The maximum value of the slider matches the maximum number of colours allowed by the selected screen mode.When you select HAM mode the slider can only take one or two value. This value is the HAM base palette colors: 16 for HAM6 and 64 for HAM8. If you don't have the AGA chipset only HAM6 will be available.
  180. @ENDNODE
  181. @NODE GAD_String "Size String Gadgets"
  182. @{u}Size String Gadgets@{uu}
  183.     With those strings labeled Height and Width you can customise the display size of the workbench. You can write directly in string gadgets if the checkmark @{"Default" link CH_Defaut} is not checked. The value entered must be between minimum and maximum values showed in Mode Properties Listview. Once a value is entered it is unchanged whatever the display mode you select and until you checked the Default gadget.
  184.     If you introduce a value under or beyond the permitted range, the string gadget will be reset to the minimum or maximum value.
  185. Almost every mode allow you to use values beyond the visible size of the screen. This virtual Workbench screen allows you to open more windows. The only limit of the virtual screen size is available chip memory.
  186. @ENDNODE
  187.                                                               @{"Size  String  Gadget"  link GAD_String}
  188. @NODE CH_Defaut "Default Checkmark"
  189. @{u}Default Checkmark@{uu}
  190.     The checkmark Default on the right of the @{"Size String Gadget" link GAD_String} allows you to directly select the default value for the height and width of the current selected display mode. These default values are in fact the visible size of the screen.
  191. @ENDNODE
  192. @NODE CH_Depl "AutoScroll Checkmark"
  193. @{u}AutoScroll Checkmark@{uu}
  194.     When this checkmark is selected the Workbench screen can be scrolled when the mouse reaches the border of the screen. This is useful if you have specified screen size greater than the visible size of the screen.
  195. @ENDNODE
  196. @NODE CH_HAM "HAM Checkmark"
  197. @{u}HAM Checkmark@{uu}
  198.     When this checkmark is selected the Workbench screen will be opened in HAM mode. You can select base color palette with the @{"colour slider" link SL_Couleur} (16 colors for HAM6 or 64 colors for HAM8).
  199. NOTE:
  200.     This is not a hack and the HAM flag is REALLY saved in the pref file, but some programs (as multiview with guide file) witch clone the Workbench for their own screen use wrong colors when workbench is in HAM. You can avoid this by opening such programs in the workbench. In this case colors are fine but the program think he is on a NO HAM screen thus pictures are not displayed in HAM. :-(
  201. @ENDNODE
  202. @NODE BT_Sauver "Save Button"
  203. @{u}Save Button@{uu}
  204.     This button is used to permanently save the preference to the system. The pref file will be saved to ENV: and ENVARC: and the program will quit. If you have opened applications on the workbench screen, the workbench may ask you to close them.
  205. @ENDNODE
  206. @NODE BT_Utiliser "Use Button"
  207. @{u}Use Button@{uu}
  208.     This button is used to temporarily save the preference to the system. The pref file will be saved to ENV: and the program will quit. If you have opened applications on workbench screen, the workbench may ask you to close them.
  209. @ENDNODE
  210. @NODE BT_Annuler "Cancel Button"
  211. @{u}Cancel Button@{uu}
  212.     Simply use this button to leave the program without updating anything.
  213. @ENDNODE
  214. @Node Author "Author"
  215. @{u}Author@{uu}
  216.     I am 23-year-old french student in electronics engineering at ENSEA in Cergy (Ecole Nationnale superieure de Electronique et ses Applications).
  217. My current Amiga config is :
  218. - A1200 (A4000 soon)  :)))
  219. - GVP A1230 (68030/40 Mhz + 68882/40 Mhz + 4 Megs)
  220. - Commodore 1942
  221. - Overdrive CD
  222. - GVP DSS8+ Sampler
  223.     MUIScreenMode is my first distributed program, I make it in C language and compiled it with SAS C v6.55. I try to be as system friendly as possible with MUIScreenMode but the only docs I have are the Commodore autodocs thus I want to know about these few points :
  224.     - Does it works on graphics cards ?
  225.     - What program do not work with a HAM workbench ?
  226. I plan in the future to do all Commodore's prefs with MUI. Are you interested?
  227.     If you have any suggestions, comments, bug reports about MUIScreenMode, you can reach me at the following addresses:
  228.           E-mail: deble@ensea.fr  (preferred)
  229.           S-mail: Cyril DEBLE
  230.                   25 rue Campo-Formio
  231.                   75013 Paris
  232.                   FRANCE
  233. @{i}Thanks to@{ui}
  234. - Commodore
  235.     For this wonderful machine : @{b}The AMIGA@{ub}.
  236. - Eric Totel
  237.     For his nice program @{i}MUIBuilder@{ui}.
  238. - Stefan Stuntz
  239.     For his @{i}Magic User Interface@{ui}.
  240. - Christophe "Oscar" Vall
  241.     For @{i}Visual@{ui}; a nice thumbnails manager. (Look on aminet)
  242. - All other PD authors
  243.     From witch I learned and borrowed a lot.
  244. - Chritoph Granz
  245.     For German docs.
  246. - Johan Sundstrom
  247.     For peering and correcting my English doc. And for is swedish docs and his icon.
  248. @EndNode   
  249. @NODE Copyright "Copyright & Disclaimer"
  250. @{u}Copyright@{uu}
  251. MUIScreenMode is 
  252.  Copyright by Cyril DEBLE in 1995.
  253.     MUIScreenMode has to be distributed as it comes. The Package must not be changed in any way. You must not do any profit by selling this Package ! For distributing it you can use every usual media, like floppy-disks, CD, hard-disks, networks etc.
  254.     MUIScreenMode is MAILWARE, if you use this program after testing it a few days, you can send me a message to tell me your opinion about MUIScreenMode.
  255.     My EMail address is @{"here" link Author}.
  256. @{u}Disclaimer@{uu}
  257. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT  PERMITTED  BY  APPLICABLE
  258. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  259. PARTIES PROVIDE THE PROGRAM "AS IS"  WITHOUT  WARRANTY  OF  ANY  KIND,  EITHER
  260. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  261. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE  RISK  AS  TO
  262. THE  QUALITY  AND  PERFORMANCE  OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
  263. PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL  NECESSARY  SERVICING,  REPAIR  OR
  264. CORRECTION.
  265. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
  266. COPYRIGHT  HOLDER,  OR  ANY  OTHER  PARTY  WHO MAY REDISTRIBUTE THE PROGRAM AS
  267. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  268. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  269. THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING  RENDERED
  270. INACCURATE  OR  LOSSES  SUSTAINED  BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  271. PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN  IF  SUCH  HOLDER  OR  OTHER
  272. PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  273. @ENDNODE
  274. @NODE History "MUIScreenMode History"
  275. @{u}History@{uu}
  276. @{b}Version 1.0 (21/3/95)@{ub}
  277. - First public release
  278. @{b}Version 1.1 (5/4/95)@{ub}
  279. - RelVerify flag for USE,SAVE and CANCEL button was not set.
  280. - Display monitor frequencies in Display info listview.
  281. - Restricted HAM mode to 6 or 8 bitplanes.
  282. - Now check if HAM is available for the selected screenmode if not -> ghost HAM gadget.
  283. - Works now with ECS and OLD chipsets.
  284. - Corrected min size, now 640x200 for all except for A2024 (1024x1024).
  285. - ScreenModes are now sorted in the screenmode listview.
  286. - Selected mode is shown in the mode list at startup.
  287. - French docs.
  288. - Installer Script.
  289. @{b}Version 1.2 (3/5/95)@{ub}
  290. - Doubleclick on a mode to use it.(No more about requester) ;-)
  291. - When you click on a mode with less color than the current color value this one is saved. (Load A2024 monitor and scan all the screenmode to see this feature)
  292. - Size of height and widh string gadget are fixed, values are now never hidden.
  293. - The screenmode listview can be controlled with the keyboard at startup.
  294. - Installer script was not installing the Def_Prefs icon.
  295. @{b}version 1.3 (11/5/95)@{ub}
  296. - Little bugfixes.
  297. - German docs.
  298. @{b}version 1.4 (8/6/95)@{ub}
  299. - Corrected English and French docs.
  300. - When saving with a icon, tooltype is set to the program name ie MUIScreenMode. (Was always Screenmode before)
  301. - Clever hotkeys for buttons. Now it use the first letter of the button string instead of a fixed letter, and if this hotkey is already used then the second letter is used and so on...
  302. - A file preset icon is not overwrited if it already exist. (Allow to keep tooltypes to their current value)
  303. - Changed locale string for load button. Now it use "Update" from workbench.catalog.
  304. - FLUSHLIBS tooltype and menu added.
  305. - About requester is back in the menu. About menu string is localised with workbench.catalog.
  306. - Tooltypes in some archive icon was wrong.
  307. - One string was not localised in the iff parser.
  308. - Load requester was reseting gadgets values when cancelled.
  309. @{b}Version 1.5 (20/6/95)@{ub}
  310. - Swedish docs.
  311. - Changed a bit the overall look of the docs (wordwrap,underline,bold...)
  312. @{u}Coming soon@{uu}
  313. - MUITime prefs ! (Almost 90% complete now) :-)
  314. @ENDNODE
  315. @NODE MUI "MUI Legalities"
  316.                             This application uses
  317.                            MUI - MagicUserInterface
  318.                     (c) Copyright 1993/94 by Stefan Stuntz
  319.     MUI is a system to generate and maintain graphical user interfaces. With the aid of a preferences program, the user of an application has the ability to customize the outfit according to his personal taste.
  320.     MUI is distributed as shareware. To obtain a complete package containing lots of examples and more information about registration please look for a file called "muiXXusr.lha" (XX means the latest version number) on your local bulletin boards or on public domain disks.
  321.              If you want to register directly, feel free to send
  322.                               DM 30.- or US$ 20.
  323.                                       to
  324.                                 Stefan Stuntz
  325.                            Eduard-Spranger-Stra
  326.                                 80935 M
  327. nchen
  328.                                    GERMANY
  329. @ENDNODE
  330.